Documentation rewrite - Get started page #3059
Conversation
daniCsorbaJB
changed the title
| </dependencies> | ||
| ``` | ||
|
|
||
| ### Add the Kotlin serialization library to a multiplatform project |
There was a problem hiding this comment.
We also mention Proguard rules (specific for Android) in the README.md. Do you plan to add them here?
There was a problem hiding this comment.
good question 🤔
I think we could add it to the Create custom serializer page (where we talk about serializer() and companion objects) Although, we could place a link to that part of the page here. 🤔
What do you think?
There was a problem hiding this comment.
I think it's a bad idea. It is not always related to custom serializer, regular @Serializable classes can have named companions as well. I would expect separate page for Proguard then (linked here)
There was a problem hiding this comment.
Fair point — thank you for the context — I added it as a collapsible section then! 👍
There was a problem hiding this comment.
I've realized we have a tip
We also provide kotlinx-serialization-core artifact that contains all serialization API but does not have a bundled serialization format with it
in our current README.md, which is missing from this document.
Perhaps it is better to place it in the serialization.md/Kotlin serialization libraries or Supported serialization formats section in the form of
Pro tip: if you do not want a dependency on a particular format (e.g., you are writing your own serialization format), you can use
kotlinx-serialization-corelibrary.
I really like the second option — let's go with that (let's put it in the supported serialization formats page) |
So, do you plan to address it? |
3 participants
This is the second part of the Kotlin Serialization rewrite.
Related YouTract ticket is: KT-80054 [Docs][Libraries] Get started with Kotlin Serialization)